PBDTResetSync

PBDTResetSync
Header:	Files.h		Carbon status:	Supported

Removes information from the desktop database. Unless you are manipulating the desktop database in the absence of the Finder, you should never use this function. This function runs synchronously.

OSErr PBDTResetSync (
    DTPBPtr paramBlock
);

paramBlock: A pointer to a desktop parameter block.

function result: A result code.

DISCUSSION

Clear all fields (other than input fields) in the parameter block that you pass to Desktop Manager functions. The relevant fields of the parameter block for this function are:

ioCompletionOn input, a universal procedure pointer to a completion function. A value of type IOCompletionUPP.
ioResultOn return, the result code of the function. A value of type OSErr.
ioDTRefNumOn input, the desktop database reference number. A value of type SInt16.
ioIndexOn input, reserved; must be set to 0. A value of type SInt16.

The PBDTReset function removes all icons, application mappings, and comments from the desktop database specified in ioDTRefNum. You can call PBDTReset only when the database is open. It remains open after the data is cleared.

Your application should not call PBDTReset unless absolutely necessary.

SPECIAL CONSIDERATIONS

All of the Desktop Manager functions may move or purge memory blocks in the application heap or for some other reason should not be called from within an interrupt. Your application should not call Desktop Manager functions at interrupt time.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.